#region (c) 2014 THN Solutions LLC. - All rights reserved
/*
Simplified BSD License (BSD)
Copyright (c) 2014, THN Solutions LLC. ( www.ThnSolutions.com )
Author: Nguyễn, M. Hải                 ( www.Minh-Hai.com     )
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this 
      list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright notice, 
      this list of conditions and the following disclaimer in the documentation 
      and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
#endregion

#region Record of Change
//             							CHANGE HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | DEVELOPER  | DESCRIPTION                                              |
// -------------------------------------------------------------------------------------
// | 14-Nov-09 | HaiNM      | First creation.                                          |
// -------------------------------------------------------------------------------------
//
#endregion

#region Record of Audit
//             							REVIEW HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | REVIEWER   | NOTES                                                    |
// -------------------------------------------------------------------------------------
// -------------------------------------------------------------------------------------
//
#endregion

#region Using directives
using System;
using System.Drawing;
using System.Windows.Forms;
using System.ComponentModel;

using Thn;
#endregion

namespace Thn.Interface.Vcl
{
    /// <summary>
    /// A custom label that appears as a link.
    /// </summary>
    [ToolboxItem(true), DefaultProperty("Text"), DefaultEvent("Click"), ToolboxBitmap(typeof(ResourceBeacon), "Thn.Interface.Vcl.Resources.Icons.LinkLabel.bmp")]
#if DEBUG
    public
#else
    public
#endif
 class LinkLabel : Label
    {
        #region Fields
        #endregion

        #region Properties

        #region Render Context
        /// <summary>
        /// Gets reference to current renderation context.
        /// </summary>
        protected new LinkLabelRenderContext RenderContext
        {
            get
            {
                return (LinkLabelRenderContext)base.RenderContext;
            }
        }
        #endregion

        #region Allow Key Prress
        bool mAllowKeyPrress = true;
        /// <summary>
        /// Gets or Sets value determines whether allow or not raise event click when user press Enter or Spacebar key.
        /// <para>Default value is true.</para>
        /// </summary>
        [Browsable(true), DefaultValue(true), Category("Appearance"), Description("Allow or not raise event click when user press Enter or Spacebar key.")]
        public bool AllowKeyPrress
        {
            get { return mAllowKeyPrress; }
            set { mAllowKeyPrress = value; }
        }
        #endregion  

        #endregion

        #region Create Render Context
        /// <summary>
        /// Create a new render context instance.
        /// </summary>
        protected override LabelRenderContext CreateRenderContext()
        {
            return new LinkLabelRenderContext();
        }
        #endregion

        #region Mouse Events

        #region On Mouse Enter
        /// <summary>
        /// Mouse enter
        /// </summary>
        protected override void OnMouseEnter(EventArgs e)
        {
            this.RenderContext.IsMouseOver = true;
            this.Cursor = Cursors.Hand;
            base.OnMouseEnter(e);
            Invalidate();
        }
        #endregion

        #region On Mouse Leave
        /// <summary>
        /// Mouse leave
        /// </summary>
        protected override void OnMouseLeave(EventArgs e)
        {
            this.RenderContext.IsMouseOver = false;
            this.Cursor = Cursors.Default;
            base.OnMouseLeave(e);
            Invalidate();
        }
        #endregion

        #endregion

        #region Keyboard Events

        #region On Key Up
        protected override void OnKeyUp(KeyEventArgs e)
        {
            if (
                mAllowKeyPrress &&
                ((e.KeyCode == Keys.Space) || (e.KeyCode == Keys.Enter))
                )
            {
                OnClick(EventArgs.Empty);
            }
            #region Defensive tracing
            else
            {
                //not interested in other keys
                base.OnKeyUp(e);
            }
            #endregion
        }
        #endregion

        #endregion

        #region Constructors
        /// <summary>
        /// Default constructor.
        /// </summary>
        public LinkLabel()
        {
            //allow this control to receive focus
            SetStyle(ControlStyles.Selectable, true);
        }
        #endregion
    }
}
